Package-level declarations

Types

Link copied to clipboard
@Serializable
value class ClaimId(val value: String) : Serializable
Link copied to clipboard
value class ClaimPath(val value: List<ClaimPathElement>)

The path is a non-empty list of elements, null values, or non-negative integers. It is used to SelectPath a particular claim in the credential or a set of claims.

Link copied to clipboard
sealed interface ClaimPathElement

Elements of a ClaimPath

Link copied to clipboard
object ClaimPathSerializer : KSerializer<ClaimPath>

Serializer for ClaimPath

Link copied to clipboard
@Serializable
value class ClaimSet(val value: List<ClaimId>) : Serializable
Link copied to clipboard
@Serializable
data class ClaimsQuery(val id: ClaimId? = null, val path: ClaimPath, val values: JsonArray? = null, val intentToRetain: Boolean? = null) : MsoMdocClaimsQueryExtension, Serializable
Link copied to clipboard
@Serializable
data class CredentialQuery(val id: QueryId, val format: Format, val meta: JsonObject, val multiple: Boolean? = null, val trustedAuthorities: List<TrustedAuthority>? = null, val requireCryptographicHolderBinding: Boolean? = null, val claims: List<ClaimsQuery>? = null, val claimSets: List<ClaimSet>? = null) : Serializable

Represents a request for a presentation of one Credential.

Link copied to clipboard
@Serializable
value class CredentialQueryIds(val value: List<QueryId>) : Serializable

A non-empty list of query ids

Link copied to clipboard
@Serializable
value class Credentials(val value: List<CredentialQuery>) : Serializable

A non-empty list of credential queries, having unique ids

Link copied to clipboard
@Serializable
data class CredentialSetQuery(val options: List<CredentialQueryIds>, val required: Boolean? = null) : Serializable
Link copied to clipboard
@Serializable
value class CredentialSets(val value: List<CredentialSetQuery>) : Serializable

A non-empty list of credential set queries

Link copied to clipboard
@Serializable
data class DCQL(val credentials: Credentials, val credentialSets: CredentialSets? = null) : Serializable
Link copied to clipboard
@Serializable
data class DCQLMetaMsoMdocExtensions(val doctypeValue: MsoMdocDocType) : Serializable

The following is an ISO mdoc specific parameter in the meta parameter

Link copied to clipboard
@Serializable
data class DCQLMetaSdJwtVcExtensions(val vctValues: List<String>) : Serializable
Link copied to clipboard

The following are ISO mdoc specific parameters to be used in a Claims Query

Link copied to clipboard
@Serializable
value class MsoMdocDocType(val value: String) : Serializable
Link copied to clipboard
@Serializable
value class QueryId(val value: String) : Serializable

The value must be a non-empty string consisting of alphanumeric, underscore (_) or hyphen (-) characters

Link copied to clipboard
@Serializable
data class TrustedAuthority(val type: TrustedAuthorityType, val values: List<String>) : Serializable
Link copied to clipboard
@Serializable
value class TrustedAuthorityType(val value: String) : Serializable

Functions

Link copied to clipboard
inline fun <T> ClaimPathElement.fold(ifAllArrayElements: () -> T, ifArrayElement: (Int) -> T, ifClaim: (String) -> T): T